Define (and use) custom component "RestRef"#155
Conversation
| ### Rest API | ||
|
|
||
| See the restref text="REST API documentation" tag="External-Task for how the API operations can be accessed via HTTP. | ||
| See the <RestRef text="REST API documentation" section="External-Task" /> for how the API operations can be accessed via HTTP. |
There was a problem hiding this comment.
All right to use the name "section" instead of "tag"?
There was a problem hiding this comment.
It may look rendered as a section, but "tag" is more precise in regard to the Open API spec
https://swagger.io/docs/specification/v3_0/grouping-operations-with-tags/
There was a problem hiding this comment.
Fixed to use "tag" and "operation".
@hauptmedia, I hope you don't mind the switch from "page" to "operation". In the PR description, I see "page" was called legacy.
|
Thank you @andreibancioiu for proposing this component. It will be helpful. Let's polish and use it then. |
|
Looks good to me. One last formal thing: Please just copy and paste this statement as first-time-contributor
|
|
I confirm that my contribution and following ones comply with the Apache License 2.0 and the Code of Conduct. |
|
Thank you a lot for this component, @andreibancioiu ! |
3 participants
Summary
RestRefMDX component for links into the published REST API referencetag/operation, drop the legacytag/pagetarget="_blank"andrel="noreferrer"restrefsnippets in the docs toRestRef, preserving tag/operation deep links instead of flattening them to the REST overviewVerification
rg -n --case-sensitive 'restref ' docs buildfinds no remaining old lowercaserestrefsnippetshttps://docs.operaton.org/reference/latest/rest-api/operaton-rest-api.jsonand confirmed every migratedtag/operationid exists in the current REST API speccurl; all returned HTTP 200git diff --checknpm run buildsucceeds; this branch still reports the known pre-existing Docusaurus broken link/anchor warnings handled separately in Fix docs link checks and enforce quality gates #115Notes
npm run typecheckis still blocked on this branch baseline by the known TypeScript 6/base config andHomepageFeaturestype issues addressed separately in Fix docs link checks and enforce quality gates #115.